/*
 * Copyright 2019 Immutables Authors and Contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.immutables.criteria.mongo;

import com.mongodb.reactivestreams.client.MongoDatabase;
import org.immutables.criteria.backend.KeyExtractor;
import org.immutables.criteria.backend.PathNaming;
import org.immutables.value.Value;

/**
 * Setup configuration to connect to MongoDB cluster
 */
@Value.Style(visibility = Value.Style.ImplementationVisibility.PACKAGE)
@Value.Immutable
public interface MongoSetup {

  @Value.Parameter
  CollectionResolver collectionResolver();

  @Value.Default
  default KeyExtractor.Factory keyExtractorFactory() {
    return KeyExtractor.defaultFactory();
  }

  /**
   * Used during query building to correctly name fields (eg. {@code a.b.c} or {@code _id}).
   */
  @Value.Default
  default PathNaming pathNaming() {
    return PathNaming.defaultNaming();
  }

  static MongoSetup of(CollectionResolver resolver) {
    return ImmutableMongoSetup.of(resolver);
  }

  static MongoSetup of(MongoDatabase database) {
    return ImmutableMongoSetup.of(CollectionResolver.defaultResolver(database, database.getCodecRegistry()));
  }

  static Builder builder() {
    return new Builder();
  }

  class Builder extends ImmutableMongoSetup.Builder {}

}
